added link to docs #486
added link to docs #486
Conversation
lib/postgrex.ex
Outdated
| @@ -79,7 +79,8 @@ defmodule Postgrex do | |||
| * `:handshake_timeout` - Connection handshake timeout in milliseconds | |||
| (defaults to `:timeout` value); | |||
| * `:ssl` - Set to `true` if ssl should be used (default: `false`); | |||
| * `:ssl_opts` - A list of ssl options, see ssl docs; | |||
| * `:ssl_opts` - A list of ssl options, see the | |||
| [ssl docs](http://erlang.org/doc/man/ssl.html); | |||
There was a problem hiding this comment.
good call. How about linking to particular function:
* `:ssl_opts` - A list of ssl options, see `:ssl.connect/2`;?
There was a problem hiding this comment.
I agree that more precise documentation would be more helpful, it's just that as this is my first PR into this project I was unsure if my suggestions was too specific.
From my understanding, the connect options the ssl_opts expects is actually tls_client_option.
:ssl_opts - A list of ssl options, see the
tls_client_optionfrom the ssl docs;
Would this be accurate?
|
Partially this was done in the #485, but I agree, that some more information in docs would be helpful for newcomers. 👍 |
|
@hauleth oh, nice, I missed that pr. @Fl4m3Ph03n1x could use also change that type to use tls_client_option as its more specific? |
|
I did some modifications, please let me know if I missed something ! |
|
Thank you! |
Adding more information on where to go for the ssl_options flag.
Follow up from this forum discussion:
https://elixirforum.com/t/how-to-connect-to-postgrex-with-ssl-certificate/26255